AdjustBorderShape

Inside Macintosh: OpenDoc Class Reference /: Part 1 - Classes and Methods / ODPart

AdjustBorderShape
The AdjustBorderShape method should adjust the shape of an embedded frame's active frame border.
ODShape AdjustBorderShape (in ODFacet embeddedFacet,
                           in ODShape shape);
embeddedFacet

A reference to an embedded facet for which the active frame border must be adjusted.
shape
A reference to a shape object defining the current active frame border, or kODNULL if the active frame border is transferred to an embedded part of another part.
return value
A reference to a revised shape object to use for the embedded frame's active frame border, clipped by this part's content and used shape.

DISCUSSION
OpenDoc calls this method when a frame embedded in this part has the selection focus. OpenDoc draws the active frame border, associated with the frame's facet, on the border of the facet's frame. Your part's AdjustBorderShape method may be called multiple times for a containing part that has several facets for the same embedded frame.
Your part's AdjustBorderShape method should clip the provided shape to account for content elements (including other embedded frames) that obscure portions of the active frame border and then return the shape. Before returning the shape object, your part's AdjustBorderShape method should call the shape object's Acquire method (unless it modifies the requested shape object and returns that same object). When the caller has finished using the returned shape object, it should call the shape object's Release method.
Your part's AdjustBorderShape method should also adjust the clip shape of your part's facet to account for portions of the active frame border that obscure your content.

OVERRIDING
When you subclass ODPart, you can override this method. Your override method must not call its inherited method; that is, your override method must implement this method's functionality completely. This method needs to be implemented only by container parts.

EXCEPTIONS

kODErrCannotEmbed
This part does not support embedding.
kODErrInvalidFacet
The specified facet is not an embedded facet of this part.

SEE ALSO
Table 2-1 on page 89 in OpenDoc Programmer's Guide.
"Adjusting the Active Frame Border" on page 151 in OpenDoc Programmer's Guide.